MarkLogic 12 Product Documentation

PUT /manage/v2/users/{id|name}/properties

Summary

This resource address can be used to update the properties for the specified user.

Response

Upon success, MarkLogic Server returns status code 204 (No Content). If the payload is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

• the manage-admin and security role
• the following privileges:

  http://marklogic.com/xdmp/privileges/manage

  http://marklogic.com/xdmp/privileges/user-set-name

  http://marklogic.com/xdmp/privileges/user-set-description

  http://marklogic.com/xdmp/privileges/user-set-roles

  http://marklogic.com/xdmp/privileges/user-set-external-names

  http://marklogic.com/xdmp/privileges/user-set-default-collections

  http://marklogic.com/xdmp/privileges/user-set-default-permissions

• the manage role, http://marklogic.com/xdmp/privileges/manage plus the following granular privileges:
  • http://marklogic.com/xdmp/privileges/create-data-user and
    http://marklogic.com/xdmp/privileges/user-set-queries to create users with queries.
  • http://marklogic.com/xdmp/privileges/user/inherit/user-ID

Usage Notes

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, roles, external-names, permissions, collections and queries are expressed in singular form. For example, in JSON, permissions is instead permission and the format is: "permission":[{"role-name":"name", "capability":"cap"}]. Please pay special attention that the singular form of queries is capability-query.

user-name

User/login name (unique)

description

An object's description.

password

Password.

external-names

The external names specifications.

This is a complex structure with the following children:

external-name

The name used to match external group name.

roles

The roles assigned. The roles assigned to the user.

This is a complex structure with the following children:

role

A role identifier (unique key).

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.

This is a complex structure with the following children:

role-name

A role name.

capability

The action/task permitted by a permission

collections

The default set of collections used in document creation.

This is a complex structure with the following children:

collection

The collection uri.

queries

This is a complex structure with the following children:

capability-query

This is a complex structure with the following children:

capability

The action/task permitted by a permission

query

This is a complex structure with the following children:

cts:query

Example

curl -X PUT  --anyauth -u admin:admin -H "Content-Type:application/json" \
-d '{"description":"joe cool"}' http://localhost:8002/manage/v2/users/Joe/properties
 
==>  Changes the description for the user, "joe," to "joe cool." 
    

Example

// JSON payload example for creating a role with queries.

$ cat payload.json

{
  "user-name": "Vanessa",
  "password": "strongpassword",
  "description": "Software development engineer",
  "capability-query": [{
    "capability": "node-update", 
    "query": {
      "elementQuery": {
        "element": ["metadata"], 
        "query": {
          "elementWordQuery": {
            "element": ["region"], 
            "text": ["NA"], 
            "options": ["lang=en"]
          }
        }
      }
    }
  }]
}

curl -X PUT -i --digest -u admin:admin -H "Content-Type:application/json" \
-d @payload.json http://localhost:8002/manage/v2/users/Vanessa/properties

==> Changes the user queries of a user, named "Vanessa, from capability "read" to
capability "node-update".
    

Example

(: XML payload for creating a user with queries :)

$ cat payload.xml

<user-properties xmlns="http://marklogic.com/manage/user/properties">
  <user-name>Vanessa</user-name>
  <password>strongpassword</password>
  <description>Software development engineer</description>
  <queries>
    <capability-query>
      <capability>node-update</capability>
      <query>
        <cts:element-query xmlns:cts="http://marklogic.com/cts">
          <cts:element>metadata</cts:element>
          <cts:element-word-query>
            <cts:element>region</cts:element>
            <cts:text xml:lang="en">NA</cts:text>
          </cts:element-word-query>
        </cts:element-query>
      </query>
    </capability-query>
  </queries>
</user-properties>

curl -X PUT -i --digest -u admin:admin -H "Content-Type:application/xml" \
-d @payload.xml http://localhost:8002/manage/v2/users

==> Changes the user queries of a user, named "Vanessa, from capability "read" to
capability "node-update".